IRIX Base Documentation 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat3 / Tk / entry.z / entry

Wrap

Text File | 2002-10-03 | 27.6 KB | 529 lines

eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) NNNNAAAAMMMMEEEE entry - Create and manipulate entry widgets SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS eeeennnnttttrrrryyyy _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s? SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS bbbbaaaacccckkkkggggrrrroooouuuunnnndddd hhhhiiiigggghhhhlllliiiigggghhhhttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd iiiinnnnsssseeeerrrrttttOOOOnnnnTTTTiiiimmmmeeee sssseeeelllleeeeccccttttFFFFoooorrrreeeeggggrrrroooouuuunnnndddd | bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh hhhhiiiigggghhhhlllliiiigggghhhhttttCCCCoooolllloooorrrr iiiinnnnsssseeeerrrrttttWWWWiiiiddddtttthhhh ttttaaaakkkkeeeeFFFFooooccccuuuussss | ccccuuuurrrrssssoooorrrr hhhhiiiigggghhhhlllliiiigggghhhhttttTTTThhhhiiiicccckkkknnnneeeessssssss jjjjuuuussssttttiiiiffffyyyy tttteeeexxxxttttVVVVaaaarrrriiiiaaaabbbblllleeee eeeexxxxppppoooorrrrttttSSSSeeeelllleeeeccccttttiiiioooonnnn iiiinnnnsssseeeerrrrttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd rrrreeeelllliiiieeeeffff xxxxSSSSccccrrrroooollllllllCCCCoooommmmmmmmaaaannnndddd ffffoooorrrreeeeggggrrrroooouuuunnnndddd iiiinnnnsssseeeerrrrttttBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh sssseeeelllleeeeccccttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd ffffoooonnnntttt iiiinnnnsssseeeerrrrttttOOOOffffffffTTTTiiiimmmmeeee sssseeeelllleeeeccccttttBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh See the ``options'' manual entry for details on the standard options. WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS Name: sssshhhhoooowwww | Class: SSSShhhhoooowwww | Command-Line Switch:----sssshhhhoooowwww | If this option is specified, then the true contents of the entry are| not displayed in the window. Instead, each character in the entry's| value will be displayed as the first character in the value of this | option, such as ``*''. This is useful, for example, if the entry is| to be used to enter a password. If characters in the entry are | selected and copied elsewhere, the information copied will be what | is displayed, not the true contents of the entry. Name: ssssttttaaaatttteeee Class: SSSSttttaaaatttteeee Command-Line Switch:----ssssttttaaaatttteeee Specifies one of two states for the entry: nnnnoooorrrrmmmmaaaallll or ddddiiiissssaaaabbbblllleeeedddd. If the entry is disabled then the value may not be changed using widget commands and no insertion cursor will be displayed, even if the input focus is in the widget. Name: wwwwiiiiddddtttthhhh Class: WWWWiiiiddddtttthhhh Command-Line Switch:----wwwwiiiiddddtttthhhh Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font. If the | value is less than or equal to zero, the widget picks a size just | large enough to hold its current text. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The eeeennnnttttrrrryyyy command creates a new window (given by the _p_a_t_h_N_a_m_e argument) and makes it into an entry widget. Additional options, described above, may be specified on the command line or in the option database to PPPPaaaaggggeeee 1111 eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) configure aspects of the entry such as its colors, font, and relief. The eeeennnnttttrrrryyyy command returns its _p_a_t_h_N_a_m_e argument. At the time this command is invoked, there must not exist a window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist. An entry is a widget that displays a one-line text string and allows that string to be edited using widget commands described below, which are typically bound to keystrokes and mouse actions. When first created, an entry's string is empty. A portion of the entry may be selected as described below. If an entry is exporting its selection (see the eeeexxxxppppoooorrrrttttSSSSeeeelllleeeeccccttttiiiioooonnnn option), then it will observe the standard X11 protocols for handling the selection; entry selections are available as type SSSSTTTTRRRRIIIINNNNGGGG. Entries also observe the standard Tk rules for dealing with the input focus. When an entry has the input focus it displays an _i_n_s_e_r_t_i_o_n _c_u_r_s_o_r to indicate where new characters will be inserted. Entries are capable of displaying strings that are too long to fit entirely within the widget's window. In this case, only a portion of the string will be displayed; commands described below may be used to change the view in the window. Entries use the standard xxxxSSSSccccrrrroooollllllllCCCCoooommmmmmmmaaaannnndddd mechanism for interacting with scrollbars (see the description of the xxxxSSSSccccrrrroooollllllllCCCCoooommmmmmmmaaaannnndddd option for details). They also support scanning, as described below. WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD The eeeennnnttttrrrryyyy command creates a new Tcl command whose name is _p_a_t_h_N_a_m_e. This command may be used to invoke various operations on the widget. It has the following general form: _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...? _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command. Many of the widget commands for entries take one or more indices as arguments. An index specifies a particular character in the entry's string, in any of the following ways: _n_u_m_b_e_r Specifies the character as a numerical index, where 0 corresponds to the first character in the string. aaaannnncccchhhhoooorrrr Indicates the anchor point for the selection, which is set | with the sssseeeelllleeeecccctttt ffffrrrroooommmm and sssseeeelllleeeecccctttt aaaaddddjjjjuuuusssstttt widget commands. eeeennnndddd Indicates the character just after the last one in the entry's string. This is equivalent to specifying a numerical index equal to the length of the entry's string. iiiinnnnsssseeeerrrrtttt Indicates the character adjacent to and immediately following the insertion cursor. PPPPaaaaggggeeee 2222 eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) sssseeeellll....ffffiiiirrrrsssstttt Indicates the first character in the selection. It is an error to use this form if the selection isn't in the entry window. sssseeeellll....llllaaaasssstttt Indicates the character just after the last one in the | selection. It is an error to use this form if the selection isn't in the entry window. @@@@_n_u_m_b_e_r In this form, _n_u_m_b_e_r is treated as an x-coordinate in the entry's window; the character spanning that x-coordinate is used. For example, ``@@@@0000'' indicates the left-most character in the window. Abbreviations may be used for any of the forms above, e.g. ``eeee'' or ``sssseeeellll....ffff''. In general, out-of-range indices are automatically rounded to the nearest legal value. The following commands are possible for entry widgets: _p_a_t_h_N_a_m_e ccccggggeeeetttt _o_p_t_i_o_n Returns the current value of the configuration option given by | _o_p_t_i_o_n. _O_p_t_i_o_n may have any of the values accepted by the eeeennnnttttrrrryyyy | command. _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...? Query or modify the configuration options of the widget. If no _o_p_t_i_o_n is specified, returns a list describing all of the available options for _p_a_t_h_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of this list). If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no _o_p_t_i_o_n is specified). If one or more _o_p_t_i_o_n-_v_a_l_u_e pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. _O_p_t_i_o_n may have any of the values accepted by the eeeennnnttttrrrryyyy command. _p_a_t_h_N_a_m_e ddddeeeelllleeeetttteeee _f_i_r_s_t ?_l_a_s_t? Delete one or more elements of the entry. _F_i_r_s_t is the index of the first character to delete, and _l_a_s_t is the index of the character | just after the last one to delete. If _l_a_s_t isn't specified it defaults to _f_i_r_s_t+1, i.e. a single character is deleted. This command returns an empty string. _p_a_t_h_N_a_m_e ggggeeeetttt Returns the entry's string. _p_a_t_h_N_a_m_e iiiiccccuuuurrrrssssoooorrrr _i_n_d_e_x Arrange for the insertion cursor to be displayed just before the character given by _i_n_d_e_x. Returns an empty string. PPPPaaaaggggeeee 3333 eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) _p_a_t_h_N_a_m_e iiiinnnnddddeeeexxxx _i_n_d_e_x Returns the numerical index corresponding to _i_n_d_e_x. _p_a_t_h_N_a_m_e iiiinnnnsssseeeerrrrtttt _i_n_d_e_x _s_t_r_i_n_g Insert the characters of _s_t_r_i_n_g just before the character indicated by _i_n_d_e_x. Returns an empty string. _p_a_t_h_N_a_m_e ssssccccaaaannnn _o_p_t_i_o_n _a_r_g_s This command is used to implement scanning on entries. It has two forms, depending on _o_p_t_i_o_n: _p_a_t_h_N_a_m_e ssssccccaaaannnn mmmmaaaarrrrkkkk _x Records _x and the current view in the entry window; used in conjunction with later ssssccccaaaannnn ddddrrrraaaaggggttttoooo commands. Typically this command is associated with a mouse button press in the widget. It returns an empty string. _p_a_t_h_N_a_m_e ssssccccaaaannnn ddddrrrraaaaggggttttoooo _x This command computes the difference between its _x argument and the _x argument to the last ssssccccaaaannnn mmmmaaaarrrrkkkk command for the widget. It then adjusts the view left or right by 10 times the difference in x-coordinates. This command is typically associated with mouse motion events in the widget, to produce the effect of dragging the entry at high speed through the window. The return value is an empty string. _p_a_t_h_N_a_m_e sssseeeelllleeeeccccttttiiiioooonnnn _o_p_t_i_o_n _a_r_g This command is used to adjust the selection within an entry. It has several forms, depending on _o_p_t_i_o_n: _p_a_t_h_N_a_m_e sssseeeelllleeeeccccttttiiiioooonnnn aaaaddddjjjjuuuusssstttt _i_n_d_e_x Locate the end of the selection nearest to the character given by _i_n_d_e_x, and adjust that end of the selection to be at _i_n_d_e_x (i.e including but not going beyond _i_n_d_e_x). The other end of the selection is made the anchor point for future sssseeeelllleeeecccctttt ttttoooo commands. If the selection isn't currently in the entry, then a new selection is created to include the characters between _i_n_d_e_x and the most recent selection anchor point, inclusive. Returns an empty string. _p_a_t_h_N_a_m_e sssseeeelllleeeeccccttttiiiioooonnnn cccclllleeeeaaaarrrr Clear the selection if it is currently in this widget. If the selection isn't in this widget then the command has no effect. Returns an empty string. _p_a_t_h_N_a_m_e sssseeeelllleeeeccccttttiiiioooonnnn ffffrrrroooommmm _i_n_d_e_x Set the selection anchor point to just before the character given by _i_n_d_e_x. Doesn't change the selection. Returns an empty string. PPPPaaaaggggeeee 4444 eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) _p_a_t_h_N_a_m_e sssseeeelllleeeeccccttttiiiioooonnnn pppprrrreeeesssseeeennnntttt Returns 1 if there is are characters selected in the entry, 0 | if nothing is selected. _p_a_t_h_N_a_m_e sssseeeelllleeeeccccttttiiiioooonnnn rrrraaaannnnggggeeee _s_t_a_r_t _e_n_d Sets the selection to include the characters starting with the | one indexed by _s_t_a_r_t and ending with the one just before _e_n_d. | If _e_n_d refers to the same character as _s_t_a_r_t or an earlier one,| then the entry's selection is cleared. _p_a_t_h_N_a_m_e sssseeeelllleeeeccccttttiiiioooonnnn ttttoooo _i_n_d_e_x If _i_n_d_e_x is before the anchor point, set the selection to the characters from _i_n_d_e_x up to but not including the anchor point. If _i_n_d_e_x is the same as the anchor point, do nothing. If _i_n_d_e_x is after the anchor point, set the selection to the characters from the anchor point up to but not including _i_n_d_e_x. The anchor point is determined by the most recent sssseeeelllleeeecccctttt ffffrrrroooommmm or sssseeeelllleeeecccctttt aaaaddddjjjjuuuusssstttt command in this widget. If the selection isn't in this widget then a new selection is created using the most recent anchor point specified for the widget. Returns an empty string. _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww _a_r_g_s This command is used to query and change the horizontal position of | the text in the widget's window. It can take any of the following | forms: _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww Returns a list containing two elements. Each element is a real| fraction between 0 and 1; together they describe the | horizontal span that is visible in the window. For example, if| the first element is .2 and the second element is .6, 20% of | the entry's text is off-screen to the left, the middle 40% is | visible in the window, and 40% of the text is off-screen to the| right. These are the same values passed to scrollbars via the | ----xxxxssssccccrrrroooollllllllccccoooommmmmmmmaaaannnndddd option. _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww _i_n_d_e_x Adjusts the view in the window so that the character given by | _i_n_d_e_x is displayed at the left edge of the window. _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww mmmmoooovvvveeeettttoooo _f_r_a_c_t_i_o_n Adjusts the view in the window so that the character _f_r_a_c_t_i_o_n of the way through the text appears at the left edge of the window. _F_r_a_c_t_i_o_n must be a fraction between 0 and 1. _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww ssssccccrrrroooollllllll _n_u_m_b_e_r _w_h_a_t This command shifts the view in the window left or right | according to _n_u_m_b_e_r and _w_h_a_t. _N_u_m_b_e_r must be an integer. _W_h_a_t| must be either uuuunnnniiiittttssss or ppppaaaaggggeeeessss or an abbreviation of one of | these. If _w_h_a_t is uuuunnnniiiittttssss, the view adjusts left or right by | _n_u_m_b_e_r average-width characters on the display; if it is ppppaaaaggggeeeessss| PPPPaaaaggggeeee 5555 eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) then the view adjusts by _n_u_m_b_e_r screenfuls. If _n_u_m_b_e_r is | negative then characters farther to the left become visible; | if it is positive then characters farther to the right become | visible. DDDDEEEEFFFFAAAAUUUULLLLTTTT BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS Tk automatically creates class bindings for entries that give them the following default behavior. In the descriptions below, ``word'' refers | to a contiguous group of letters, digits, or ``_'' characters, or any | single character other than these. [1] Clicking mouse button 1 positions the insertion cursor just before the character underneath the mouse cursor, sets the input focus to this widget, and clears any selection in the widget. Dragging with mouse button 1 strokes out a selection between the insertion cursor and the character under the mouse. [2] Double-clicking with mouse button 1 selects the word under the mouse and positions the insertion cursor at the beginning of the word. Dragging after a double click will stroke out a selection consisting of whole words. [3] Triple-clicking with mouse button 1 selects all of the text in the entry and positions the insertion cursor before the first character. [4] The ends of the selection can be adjusted by dragging with mouse button 1 while the Shift key is down; this will adjust the end of the selection that was nearest to the mouse cursor when button 1 was pressed. If the button is double-clicked before dragging then the selection will be adjusted in units of whole words. [5] Clicking mouse button 1 with the Control key down will position the insertion cursor in the entry without affecting the selection. [6] If any normal printing characters are typed in an entry, they are inserted at the point of the insertion cursor. [7] The view in the entry can be adjusted by dragging with mouse button 2. If mouse button 2 is clicked without moving the mouse, the selection is copied into the entry at the position of the insertion cursor. [8] If the mouse is dragged out of the entry on the left or right sides while button 1 is pressed, the entry will automatically scroll to make more text visible (if there is more text off-screen on the side where the mouse left the window). [9] The Left and Right keys move the insertion cursor one character to the left or right; they also clear any selection in the entry and set the selection anchor. If Left or Right is typed with the Shift key down, then the insertion cursor moves and the selection is PPPPaaaaggggeeee 6666 eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) extended to include the new character. Control-Left and Control- Right move the insertion cursor by words, and Control-Shift-Left and Control-Shift-Right move the insertion cursor by words and also extend the selection. Control-b and Control-f behave the same as Left and Right, respectively. Meta-b and Meta-f behave the same as Control-Left and Control-Right, respectively. [10] The Home key, or Control-a, will move the insertion cursor to the beginning of the entry and clear any selection in the entry. Shift-Home moves the insertion cursor to the beginning of the entry and also extends the selection to that point. [11] The End key, or Control-e, will move the insertion cursor to the end of the entry and clear any selection in the entry. Shift-End moves the cursor to the end and extends the selection to that point. [12] The Select key and Control-Space set the selection anchor to the position of the insertion cursor. They don't affect the current selection. Shift-Select and Control-Shift-Space adjust the selection to the current position of the insertion cursor, selecting from the anchor to the insertion cursor if there was not any selection previously. [13] Control-/ selects all the text in the entry. [14] Control-\ clears any selection in the entry. [15] The F16 key (labelled Copy on many Sun workstations) or Meta-w copies the selection in the widget to the clipboard, if there is a selection. [16] The F20 key (labelled Cut on many Sun workstations) or Control-w copies the selection in the widget to the clipboard and deletes the selection. If there is no selection in the widget then these keys have no effect. [17] The F18 key (labelled Paste on many Sun workstations) or Control-y inserts the contents of the clipboard at the position of the insertion cursor. [18] The Delete key deletes the selection, if there is one in the entry. If there is no selection, it deletes the character to the right of the insertion cursor. [19] The BackSpace key and Control-h delete the selection, if there is one in the entry. If there is no selection, it deletes the character to the left of the insertion cursor. [20] Control-d deletes the character to the right of the insertion cursor. PPPPaaaaggggeeee 7777 eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) eeeennnnttttrrrryyyy((((3333TTTTkkkk)))) [21] Meta-d deletes the word to the right of the insertion cursor. [22] Control-k deletes all the characters to the right of the insertion cursor. [23] Control-w deletes the word to the left of the insertion cursor. [24] Control-t reverses the order of the two characters to the right of the insertion cursor. If the entry is disabled using the ----ssssttttaaaatttteeee option, then the entry's view can still be adjusted and text in the entry can still be selected, but no insertion cursor will be displayed and no text modifications will take place. The behavior of entries can be changed by defining new bindings for individual widgets or by redefining the class bindings. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS entry, widget PPPPaaaaggggeeee 8888